Version: V3.0

User Management API

Get User List

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
page_size	Integer	Body	Yes	Page size
page_index	Integer	Body	Yes	Page index

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	[]Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
residence_id	String	Body	Residence ID
family_name	String	Body	Family name
residence_no	String	Body	Residence number
building_id	String	Body	Building ID
building_name	String	Body	Building name
account_id	String	Body	Account ID
account_name	String	Body	Account name
first_name	String	Body	First name
last_name	String	Body	Last name
email	String	Body	Email
phone	String	Body	Phone
auth	String	Body	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user
region	String	Body	Region
payment_status	String	Body	Payment status, inactivated or normal or expired

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_list",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "page_size": 1,
    "page_index": 1,
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": [
    {
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "family_name": "test",
      "residence_no": "101",
      "building_id": "b1a621c1ae77040d697bd2134700f57ee",
      "building_name": "AB01",
      "account_id": "a1a621c1ae77040d697bd2134700f57ee",
      "account_name": "test@akubela.com",
      "first_name": "Fly",
      "last_name": "Dom",
      "phone": "1234567",
      "email": "test@akubela.com",
      "auth": "admin",
      "region": "Island",
      "payment_status": "normal"
    }
  ]
}

Failure Return Example

See Failure Return Example

Get User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
family_name	String	Body	Family name
residence_no	String	Body	Residence number
building_id	String	Body	Building ID
building_name	String	Body	Building name
account_name	String	Body	Account name
first_name	String	Body	First name
last_name	String	Body	Last name
email	String	Body	Email
phone	String	Body	Phone
auth	String	Body	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user
region	String	Body	Region
payment_status	String	Body	Payment status, inactivated or normal or expired

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724721898925,
  "result": {
    "family_name": "test",
    "residence_no": "101",
    "building_id": "b1a621c1ae77040d697bd2134700f57ee",
    "building_name": "AB01",
    "account_name": "test@akubela.com",
    "first_name": "Fly",
    "last_name": "Dom",
    "phone": "1234567",
    "email": "test@akubela.com",
    "auth": "admin",
    "region": "Island",
    "payment_status": "normal"
  }
}

Failure Return Example

See Failure Return Example

Create User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
building_id	String	Body	Yes	Building ID
first_name	String	Body	Yes	First name
last_name	String	Body	Yes	Last name
email	String	Body	Yes	Email
auth	String	Body	Yes	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
account_id	String	Body	Account ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "building_id": "br2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "first_name": "Fly",
    "last_name": "Dom",
    "email": "test@akubela.com",
    "auth": "admin"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "account_id": "a1a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Batch Create User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	[]Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
building_id	String	Body	Yes	Building ID
first_name	String	Body	Yes	First name
last_name	String	Body	Yes	Last name
email	String	Body	Yes	Email
auth	String	Body	Yes	Account authorization admin: owner, the top administrator user: family administrator guest: family ordinary user

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_create_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": [
    {
      "building_id": "br2c4b070cc928496198944858b344fc6",
      "residence_id": "r2c4b070cc928496198944858b344fc68",
      "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
      "first_name": "Fly",
      "last_name": "Dom",
      "email": "test@akubela.com",
      "auth": "admin"
    }
  ]
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Update User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
first_name	String	Body	Yes	First name
last_name	String	Body	Yes	Last name

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "first_name": "Fly",
    "last_name": "Dom"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Update User Password

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
new_password	String	Body	Yes	New password

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_password",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "new_password": "new_1234567As"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Delete User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
account_id	String	Body	Yes	Account ID
residence_id	String	Body	Yes	Residence ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "residence_id": "re1adc223cc4b3bedb6bd4742dedcfa52",
    "account_id": "a1b5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Batch Delete User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
accounts	[]Object<account>	Body	Yes	Account information

account description

Parameter Name	Type	Location	Required	Description
account_id	String	Body	Yes	Account ID
residence_id	String	Body	Yes	Residence ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "batch_delete_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "p31adc223cc4b3bedb6bd4742dedcfa52",
    "accounts": [
      {
        "residence_id": "re1adc223cc4b3bedb6bd4742dedcfa52",
        "account_id": "a1b5a73f8dd84abaa94dcs248be49b0d1"
      }
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Import User Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
file_name	String	Body	Yes	File name
file_url	String	Body	Yes	File URL

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
task_id	String	Body	Task ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-user"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

Failure Return Example

See Failure Return Example

Get User Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
faces	[]Object<face>	Body	Face information
pin_codes	[]Object<pin_code>	Body	PIN code information
rf_cards	[]Object<rf_card>	Body	RF card information
access_groups	[]Object<access_group>	Body	Access group information
floor_access	[]String	Body	Floor access

face description

Parameter Name	Type	Location	Description
face_id	String	Body	Face ID
created_time	String	Body	Created time, UTC
creator	String	Body	Creator

pin_code description

Parameter Name	Type	Location	Description
pin_code_id	String	Body	PIN code ID
number	String	Body	Number
created_time	String	Body	Created time, UTC
creator	String	Body	Creator

rf_card description

Parameter Name	Type	Location	Description
rf_card_id	String	Body	RF card ID
number	String	Body	Number
created_time	String	Body	Created time, UTC
creator	String	Body	Creator

access_group description

Parameter Name	Type	Location	Description
access_group_id	String	Body	Access group ID
access_group_name	String	Body	Access group name
access_group_type	String	Body	Access group type, system or customized

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "get_user_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "account_id": "a1a621c1ae77040d697bd2134700f57ee",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1724816274618,
  "result": {
    "floor_access": [
      "1",
      "2"
    ],
    "faces": [
      {
        "face_id": "fbr2c4b070cc928496198944858b344fc",
        "created_time": "2024-07-17 09:00:46",
        "creator": "pm"
      }
    ],
    "pin_codes": [
      {
        "pin_code_id": "pbr2c4b070cc928496198944858b344fc",
        "number": "123456",
        "created_time": "2024-07-17 19:00:46",
        "creator": "pm"
      }
    ],
    "rf_cards": [
      {
        "rf_card_id": "rbr2c4b070cc928496198944858b344fc",
        "number": "123456",
        "created_time": "2024-07-17 14:00:46",
        "creator": "pm"
      }
    ],
    "access_groups": [
      {
        "access_group_name": "test",
        "access_group_id": "arbr2c4b070cc928496198944858b344f",
        "access_group_type": "system"
      }
    ]
  }
}

Failure Return Example

See Failure Return Example

Update User Floor Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
floor_access	[]String	Body	No	Floor access

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "update_user_floor_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "floor_access": [
      "all"
    ]
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Create User PIN Code Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
number	String	Body	Yes	Number

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
pin_code_id	String	Body	PIN code ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_pin_code_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "number": "1234567"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "pin_code_id": "p1a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Delete User PIN Code Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
pin_code_id	String	Body	Yes	PIN code ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_pin_code_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "pin_code_id": "pdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Create User RF Card Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
number	String	Body	Yes	Number

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
rf_card_id	String	Body	RF card ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "number": "1234567"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "rf_card_id": "r1a621c1ae77040d697bd2134700f57ea"
  }
}

Failure Return Example

See Failure Return Example

Delete User RF Card Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
rf_card_id	String	Body	Yes	RF card ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "rf_card_id": "rdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Create User Face Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
face_picture_url	String	Body	Yes	Face picture URL

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "create_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "face_picture_url": "https://akcs.akubela.com/test"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Delete User Face Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
residence_id	String	Body	Yes	Residence ID
account_id	String	Body	Yes	Account ID
face_id	String	Body	Yes	Face ID

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object	Body	Return result

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "delete_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "account_id": "ar2c4b070cc928496198944858b344fc6",
    "residence_id": "r2c4b070cc928496198944858b344fc68",
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "face_id": "fdb5a73f8dd84abaa94dcs248be49b0d1"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {}
}

Failure Return Example

See Failure Return Example

Import User PIN Code and RF Card Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
file_name	String	Body	Yes	File name
file_url	String	Body	Yes	File URL

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
task_id	String	Body	Task ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_pin_code_and_rf_card_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-pin-card"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

Failure Return Example

See Failure Return Example

Import User Face Access Information

Request URL

POST /api/v1.0/invoke/open-ability/method/manager-commands

Request Parameter

Parameter Name	Type	Location	Required	Description
Content-Type	String	Header	Yes	Content type, the value is application/json
Accept	String	Header	Yes	Accept, the value is application/json
Authorization	String	Header	Yes	Bearer authorization, access token
command	String	Body	Yes	Command name
id	String	Body	Yes	Command ID
param	Object<param>	Body	Yes	Command parameter

param description

Parameter Name	Type	Location	Required	Description
project_id	String	Body	Yes	Project ID
file_name	String	Body	Yes	File name
file_url	String	Body	Yes	File URL

Return Parameter

Parameter Name	Type	Location	Description
Content-Type	String	Header	Content type, the value is application/json
success	Boolean	Body	Whether the request is successful or not? true: success false: failure
timestamp	Integer	Body	Timestamp
result	Object<result>	Body	Return result

result description

Parameter Name	Type	Location	Description
task_id	String	Body	Task ID

Request Example

POST /api/v1.0/invoke/open-ability/method/manager-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
  "command": "import_user_face_access_info",
  "id": "c45e846ca23ab42c9ae469d988ae32a96",
  "param": {
    "project_id": "pr31adc223cc4b3bedb6bd4742dedcfa5",
    "file_name": "test",
    "file_url": "https://test.akubela.com/test-face"
  }
}

Success Return Example

Status Code: 200

Content-Type: application/json

{
  "success": true,
  "timestamp": 1540869200562,
  "result": {
    "task_id": "tpr31adc223cc4b3bedb6bd4742dedcfa"
  }
}

Failure Return Example

See Failure Return Example

Get User List​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Create User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Batch Create User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Update User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Update User Password​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Delete User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Batch Delete User Information​

Request URL​

Request Parameter​

param description​

account description​

Return Parameter​

Request Example​

Success Return Example​

Failure Return Example​

Import User Information​

Request URL​

Request Parameter​

param description​

Return Parameter​

result description​

Request Example​

Success Return Example​

Failure Return Example​

Get User Access Information​

Request URL​

Request Parameter​

Get User List

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get User Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Create User Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Batch Create User Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Update User Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Update User Password

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Delete User Information

Request URL

Request Parameter

param description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Batch Delete User Information

Request URL

Request Parameter

param description

account description

Return Parameter

Request Example

Success Return Example

Failure Return Example

Import User Information

Request URL

Request Parameter

param description

Return Parameter

result description

Request Example

Success Return Example

Failure Return Example

Get User Access Information

Request URL

Request Parameter